/**
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2009 Sun Microsystems Inc. All Rights Reserved
 *
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at
 * https://opensso.dev.java.net/public/CDDLv1.0.html or
 * opensso/legal/CDDLv1.0.txt
 * See the License for the specific language governing
 * permission and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL
 * Header Notice in each file and include the License file
 * at opensso/legal/CDDLv1.0.txt.
 * If applicable, add the following below the CDDL Header,
 * with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * $Id: FedMonSAML1Svc.java,v 1.1 2009/06/19 02:48:04 bigfatrat Exp $
 *
 */

package com.sun.identity.plugin.monitoring;


/**
 *  This interface defines methods which will be invoked by the
 *  Federation Framework to update monitoring-related counters
 */

public interface FedMonSAML1Svc {

    String ASSERTIONS = "Assertions";
    String ARTIFACTS = "Artifacts";
    String CREAD = "Read";
    String CWRITE = "Write";
    String CHIT = "Hit";
    String CMISS = "Miss";
    String SOAPRCVR = "SAMLSOAPReceiver";
    String POSTPROFILE = "SAMLPostProfile";
    String SAMLAWARE = "SAMLAware";
    String EPRQTIN = "RqtIn";
    String EPRQTOUT = "RqtOut";
    String EPRQTFAILED = "RqtFailed";
    String EPRQTABORTED = "RqtAborted";

    /**
     * Initializes the provider.
     */
    public void init();

    /**
     *  increment number of reads, writes, hits, or misses
     *  for the SAML1 Assertions or Artifacts Cache.
     *  @param assertOrArtifact Whether the Assertions or Artifacts Cache
     *  @param rWHM Read, Write, Hit, or Miss entry to increment
     */
    public void incSAML1Cache(String assertOrArtifact, String rWHM);
}
